/*
 * Copyright 2016-2019 yoara
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package yhao.infra.service.log.dataoperate.annotation;

import yhao.infra.service.log.dataoperate.enums.DataLoggerTypeEnum;
import yhao.infra.service.log.dataoperate.enums.DataOperateTypeEnum;
import yhao.infra.common.model.Entity;

import java.lang.annotation.*;

/**
 * 操作日志方法注解
 *
 * @author yoara
 */
@Documented
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface DataOperateLogMethod {
	/**
	 * 方法类型
	 * @see {@link DataOperateTypeEnum}
     */
	DataOperateTypeEnum value();

	/**
	 * 待操作参数在参数列表中的下标位置
     */
	int index() default 0;

	/**
	 * 待操作数据的类型
	 */
	Class operateEntity() default Entity.class;

	/**
	 * 忽略null值
	 */
	boolean ignoreNull() default true;

	/**
	 * 是否异步记录
	 */
	boolean async() default true;
	/**
	 * 日志类型
	 */
	DataLoggerTypeEnum loggerType() default DataLoggerTypeEnum.NORMAL;

}
